<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<title>Docs For Class Smithy_Plugin_Cache</title>
	<link rel="stylesheet" type="text/css" href="../media/style.css">
	<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
	<td class="header-top-left"><img src="../media/logo.png" border="0" alt="phpDocumentor " /></td>
    <td class="header-top-right">Smithy_Plugin<br /><div class="header-top-right-subpackage"></div></td>
  </tr>
  <tr><td colspan="2" class="header-line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td colspan="2" class="header-menu">
      
                                                                                              
                                    		[ <a href="../classtrees_Smithy_Plugin.html" class="menu">class tree: Smithy_Plugin</a> ]
		[ <a href="../elementindex_Smithy_Plugin.html" class="menu">index: Smithy_Plugin</a> ]
            [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td colspan="2" class="header-line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="195" class="menu">
		<div class="package-title">Smithy_Plugin</div>
      <b>Packages:</b><br />
  <div class="package">
              <a href="../li_default.html">default</a><br />
              <a href="../li_Smithy.html">Smithy</a><br />
              <a href="../li_Smithy_Db.html">Smithy_Db</a><br />
              <a href="../li_Smithy_Form.html">Smithy_Form</a><br />
              <a href="../li_Smithy_Model.html">Smithy_Model</a><br />
              <a href="../li_Smithy_Plugin.html">Smithy_Plugin</a><br />
              <a href="../li_Smithy_View.html">Smithy_View</a><br />
      	</div>
      <br />
                        <b>Files:</b><br />
        <div class="package">
				<span style="padding-left: 1em;"><a href="../Smithy_Plugin/_Plugin---Cache.php.html">Cache.php</a></span><br />
			<span style="padding-left: 1em;"><a href="../Smithy_Plugin/_Plugin---Initialize.php.html">Initialize.php</a></span><br />
	  </div>
            <br />
                  <b>Classes:</b><br />
        <div class="package">
		    		<a href="../Smithy_Plugin/Smithy_Plugin_Cache.html">Smithy_Plugin_Cache</a>    	 <br />
	    		<a href="../Smithy_Plugin/Smithy_Plugin_Initialize.html">Smithy_Plugin_Initialize</a>    	 <br />
	  </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: Smithy_Plugin_Cache</h1>
Source Location: /Plugin/Cache.php<br /><br />

<h2 class="class-name">Class Smithy_Plugin_Cache</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Class Overview</div>
	<div class="nav-bar">
					<span class="disabled">Class Overview</span>
						
											| <a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
														| <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
								</div>
	<div class="info-box-body">
		<table width="100%" border="0">
		<tr><td valign="top" width="60%" class="class-overview">

        		<p align="center" class="short-description"><strong>Cacheing plugin for Zend Framework applications
</strong></p>

		<p class="notes">
			Located in <a class="field" href="_Plugin---Cache.php.html">/Plugin/Cache.php</a> [<span class="field">line <a href="../__filesource/fsource_Smithy_Plugin__PluginCache.php.html#a11">11</a></span>]
		</p>

		
		<pre>Zend_Controller_Plugin_Abstract
   |
   --Smithy_Plugin_Cache</pre>

		
				<strong>Author(s):</strong>
		<ul>
		  			 			 <li>Kovács Tamás</li>
			 		  		</ul>
		
		
<strong>Information Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
	</table>
		</td>

				<td valign="top" width="20%" class="class-overview">
		<p align="center" class="short-description"><strong><a href="#sec_vars">Properties</a></strong></p>
		<ul>
		  		  <li><a href="../Smithy_Plugin/Smithy_Plugin_Cache.html#var$doNotCache">$doNotCache</a></li>
		  		  <li><a href="../Smithy_Plugin/Smithy_Plugin_Cache.html#var$_cache">$_cache</a></li>
		  		  <li><a href="../Smithy_Plugin/Smithy_Plugin_Cache.html#var$_key">$_key</a></li>
		  		</ul>
		</td>
		
				<td valign="top" width="20%" class="class-overview">
		<p align="center" class="short-description"><strong><a href="#sec_methods">Methods</a></strong></p>
		<ul>
		  		  <li><a href="../Smithy_Plugin/Smithy_Plugin_Cache.html#method__construct">__construct</a></li>
		  		  <li><a href="../Smithy_Plugin/Smithy_Plugin_Cache.html#methoddispatchLoopShutDown">dispatchLoopShutDown</a></li>
		  		  <li><a href="../Smithy_Plugin/Smithy_Plugin_Cache.html#methoddispatchLoopStartup">dispatchLoopStartup</a></li>
		  		  <li><a href="../Smithy_Plugin/Smithy_Plugin_Cache.html#methodgetCache">getCache</a></li>
		  		</ul>
		</td>
		
		</tr></table>
		<div class="top">[ <a href="#top">Top</a> ]</div>
	</div>
</div>




	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Property Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Class Overview</a>
									| <span class="disabled">Property Summary</span> | <a href="#sec-vars">Properties Detail</a>
												| <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
							    				</div>
		<div class="info-box-body">
			<div class="var-summary">
			<table border="0" cellspacing="0" cellpadding="0" class="var-summary">
										<div class="var-title">
					<tr><td class="var-title">static <span class="var-type-summary">bool</span>&nbsp;&nbsp;</td>
					<td class="var-title"><a href="#$doNotCache" title="details" class="var-name-summary">$doNotCache</a>&nbsp;&nbsp;</td>
					<td class="var-summary-description"></td></tr>
				</div>
																																		<div class="var-title">
					<tr><td class="var-title"><span class="var-type-summary">Zend_Cache</span>&nbsp;&nbsp;</td>
					<td class="var-title"><a href="#$_cache" title="details" class="var-name-summary">$_cache</a>&nbsp;&nbsp;</td>
					<td class="var-summary-description"></td></tr>
				</div>
													<div class="var-title">
					<tr><td class="var-title"><span class="var-type-summary">string</span>&nbsp;&nbsp;</td>
					<td class="var-title"><a href="#$_key" title="details" class="var-name-summary">$_key</a>&nbsp;&nbsp;</td>
					<td class="var-summary-description">The current request's cache key</td></tr>
				</div>
										</table>
			</div>
			<br /><div class="top">[ <a href="#top">Top</a> ]</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Class Overview</a>
																		| <a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
							    					| <span class="disabled">Method Summary</span> | <a href="#sec-methods">Methods Detail</a>
		</div>
		<div class="info-box-body">
			<div class="method-summary">
				<table border="0" cellspacing="0" cellpadding="0" class="method-summary">
																																																<div class="method-definition">
											<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
										<td class="method-definition"><a href="#__construct" title="details" class="method-name">__construct</a>()&nbsp;&nbsp;</td>
					<td class="method-definition">Constructor: Initialize cache.</td></tr>
				</div>
																<div class="method-definition">
											<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
										<td class="method-definition"><a href="#dispatchLoopShutDown" title="details" class="method-name">dispatchLoopShutDown</a>()&nbsp;&nbsp;</td>
					<td class="method-definition">Store cache</td></tr>
				</div>
																<div class="method-definition">
											<tr><td class="method-definition"><span class="method-result">void</span>&nbsp;&nbsp;</td>
										<td class="method-definition"><a href="#dispatchLoopStartup" title="details" class="method-name">dispatchLoopStartup</a>()&nbsp;&nbsp;</td>
					<td class="method-definition">Start caching.</td></tr>
				</div>
																<div class="method-definition">
											<tr><td class="method-definition"><span class="method-result">bool</span>&nbsp;&nbsp;</td>
										<td class="method-definition"><a href="#getCache" title="details" class="method-name">getCache</a>()&nbsp;&nbsp;</td>
					<td class="method-definition">Get cache</td></tr>
				</div>
												</table>
			</div>
			<br /><div class="top">[ <a href="#top">Top</a> ]</div>
		</div>
	</div>

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Properties</div>
		<div class="nav-bar">
			<a href="#sec-description">Class Overview</a>
													| <a href="#sec-var-summary">Property Summary</a> | <span class="disabled">Properties Detail</span>
															| <a href="#sec-method-summary">Method Summary</a> | <a href="#sec-methods">Methods Detail</a>
												</div>
		<div class="info-box-body">
			<a name="var$doNotCache" id="$doNotCache"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">bool</span>&nbsp;&nbsp;
			<span class="var-name">$doNotCache</span>
			 = <span class="var-default"> FALSE</span>			<span class="smalllinenumber">[line <a href="../__filesource/fsource_Smithy_Plugin__PluginCache.php.html#a27">27</a>]</span>
		</span>
	</div>

		<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


	
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$_cache" id="$_cache"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">Zend_Cache</span>&nbsp;&nbsp;
			<span class="var-name">$_cache</span>
			 = <span class="var-default"> NULL</span>			<span class="smalllinenumber">[line <a href="../__filesource/fsource_Smithy_Plugin__PluginCache.php.html#a16">16</a>]</span>
		</span>
	</div>

		<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


	
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="var$_key" id="$_key"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>&nbsp;&nbsp;
			<span class="var-name">$_key</span>
			 = <span class="var-default"> ''</span>			<span class="smalllinenumber">[line <a href="../__filesource/fsource_Smithy_Plugin__PluginCache.php.html#a22">22</a>]</span>
		</span>
	</div>

	<p align="center" class="short-description"><strong>The current request's cache key
</strong></p>
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>protected</td>
  </tr>
</table>
<br />


	
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
		</div>
	</div>

	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Class Overview</a>
																		| <a href="#sec-var-summary">Property Summary</a> | <a href="#sec-vars">Properties Detail</a>
																	| <a href="#sec-method-summary">Method Summary</a> | <span class="disabled">Methods Detail</span>
					</div>
		<div class="info-box-body">
			<a name='method_detail'></a>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">

<div class="method-header">
	<span class="method-title">Constructor __construct</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Smithy_Plugin__PluginCache.php.html#a36">36</a>]</span>
</div>
<br />

	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
		<code>void __construct(
array|Zend_Config
$options&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

	<p align="center" class="short-description"><strong>Constructor: Initialize cache.
</strong></p>

			<strong>Parameters:</strong><br />
			<table border="0" cellspacing="0" cellpadding="0">
					<tr><td class="indent">
				<span class="var-type">array|Zend_Config</span>&nbsp;&nbsp;</td>
				<td>
				<span class="var-name">$options:&nbsp;</span></td>
				<td>
							</td></tr>
				</table>

	<br />
	
<strong>Information Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Throws:</strong>&nbsp;&nbsp;</td><td>Exception</td>
  </tr>
</table>

		
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methoddispatchLoopShutDown" id="dispatchLoopShutDown"><!-- --></a>
<div class="oddrow">

<div class="method-header">
	<span class="method-title">dispatchLoopShutDown</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Smithy_Plugin__PluginCache.php.html#a94">94</a>]</span>
</div>
<br />

	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
		<code>void dispatchLoopShutDown(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

	<p align="center" class="short-description"><strong>Store cache
</strong></p>

	<br />
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


		
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methoddispatchLoopStartup" id="dispatchLoopStartup"><!-- --></a>
<div class="evenrow">

<div class="method-header">
	<span class="method-title">dispatchLoopStartup</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Smithy_Plugin__PluginCache.php.html#a69">69</a>]</span>
</div>
<br />

	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
		<code>void dispatchLoopStartup(

$request&nbsp;
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

	<p align="center" class="short-description"><strong>Start caching.
</strong></p>
<span class="description"><p>Determine if we have a cache hit. If we do than we pull the data from the cache and return it as response,  otherwise we start caching.</p></span>
			<strong>Parameters:</strong><br />
			<table border="0" cellspacing="0" cellpadding="0">
					<tr><td class="indent">
				<span class="var-type">Zend_Controller_Request_Abstract</span>&nbsp;&nbsp;</td>
				<td>
				<span class="var-name">$request:&nbsp;</span></td>
				<td>
							</td></tr>
				</table>

	<br />
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


		
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
<a name="methodgetCache" id="getCache"><!-- --></a>
<div class="oddrow">

<div class="method-header">
	<span class="method-title">getCache</span>&nbsp;&nbsp;<span class="smalllinenumber">[line <a href="../__filesource/fsource_Smithy_Plugin__PluginCache.php.html#a112">112</a>]</span>
</div>
<br />

	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code-border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">&nbsp;
		<code>bool getCache(
)</code>
    </td></tr></table>
    </td></tr></table><br /></div>

	<p align="center" class="short-description"><strong>Get cache
</strong></p>

	<br />
	<strong>API Tags:</strong><br />
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td class="indent"><strong>Access:</strong>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
<br />


		
		<br />
	<div class="top">[ <a href="#top">Top</a> ]</div>
</div>
		</div>
	</div>


        <div class="credit">
		    <hr class="separator" />
		    Documentation generated on Sun, 25 Jan 2009 02:41:06 +0100 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.1</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>